<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - org.brophy.js.array</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/org.brophy.js.ajax.html">org.brophy.js.ajax</a></li>
	
	<li><a href="../symbols/org.brophy.js.ajax.ReplyManager.html">org.brophy.js.ajax.ReplyManager</a></li>
	
	<li><a href="../symbols/org.brophy.js.array.html">org.brophy.js.array</a></li>
	
	<li><a href="../symbols/org.brophy.js.constant.html">org.brophy.js.constant</a></li>
	
	<li><a href="../symbols/org.brophy.js.drag.html">org.brophy.js.drag</a></li>
	
	<li><a href="../symbols/org.brophy.js.drag.Dragger.html">org.brophy.js.drag.Dragger</a></li>
	
	<li><a href="../symbols/org.brophy.js.event.html">org.brophy.js.event</a></li>
	
	<li><a href="../symbols/org.brophy.js.select.html">org.brophy.js.select</a></li>
	
	<li><a href="../symbols/org.brophy.js.util.html">org.brophy.js.util</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace org.brophy.js.array
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				
Library of useful functions for dealing with arrays in              HTML pages.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/D__matt_Computer_JavaScript_orgbrophyjs_trunk_org_brophy_js_array.js.html">array.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class org.brophy.js.array.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/org.brophy.js.array.html#constructor">org.brophy.js.array</a></b>
							</div>
							<div class="description">Library of useful functions for dealing with arrays in              HTML pages.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class org.brophy.js.array.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.array.<b><a href="../symbols/org.brophy.js.array.html#.indexOf">indexOf</a></b>(arr, val, cmpFunc)
								</div>
								<div class="description">Finds the index of a value 'val' in an array 'arr'.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.array.<b><a href="../symbols/org.brophy.js.array.html#.sortArray">sortArray</a></b>(arr, cmpFunc)
								</div>
								<div class="description">Sorts the array 'arr'</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.array.<b><a href="../symbols/org.brophy.js.array.html#.sortArrayOfObjects">sortArrayOfObjects</a></b>(arr, prop, cmpFunc, ignore_n)
								</div>
								<div class="description">Sorts the array 'arr' in whatever fashion you desire.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>org.brophy.js.array</b>
				</div>
				
				<div class="description">
					Library of useful functions for dealing with arrays in              HTML pages.
					
				</div>
				
				
				
				
					
					
					
					
					
					
						<dl class="detailList">
						<dt class="heading">Requires:</dt>
						
							<dd>This library requires the <a href="http://www.mochikit.com">             MochiKit</a> JavaScript library              (version 1.4+).</dd>
						
						</dl>
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".indexOf"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{number}</span>
					<span class="light">org.brophy.js.array.</span><b>indexOf</b>(arr, val, cmpFunc)
					
					</div>
					<div class="description">
						Finds the index of a value 'val' in an array 'arr'.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>arr</b>
									
								</dt>
								<dd>The array to search</dd>
							
								<dt>
									<b>val</b>
									
								</dt>
								<dd>The value to look for</dd>
							
								<dt>
									<b>cmpFunc</b>
									<i>Optional</i>
								</dt>
								<dd>A function following the MochiKit.Base.compare function syntax           for comparing two items and returning 0 if equal.  If no           function is passed, then the MochiKit.Base.compare() function           will be used.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The index in the array, otherwise -1</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".sortArray"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{array}</span>
					<span class="light">org.brophy.js.array.</span><b>sortArray</b>(arr, cmpFunc)
					
					</div>
					<div class="description">
						Sorts the array 'arr'
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>arr</b>
									
								</dt>
								<dd>The array to be sorted</dd>
							
								<dt>
									<b>cmpFunc</b>
									<i>Optional</i>
								</dt>
								<dd>A function following the MochiKit.Base.compare function syntax           for comparing two items and returning 1, 0, or -1.  If no           function is passed, then the MochiKit.Base.compare() function           will be used.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The sorted array.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".sortArrayOfObjects"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{array}</span>
					<span class="light">org.brophy.js.array.</span><b>sortArrayOfObjects</b>(arr, prop, cmpFunc, ignore_n)
					
					</div>
					<div class="description">
						Sorts the array 'arr' in whatever fashion you desire.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>arr</b>
									
								</dt>
								<dd>The array to be sorted</dd>
							
								<dt>
									<b>prop</b>
									<i>Optional</i>
								</dt>
								<dd>Assuming 'arr' is an array of objects, 'prop' identifies the           property to sort on.  If 'prop' is not passed, then the array          is assumed to be an array of strings and is sorted as such.</dd>
							
								<dt>
									<b>cmpFunc</b>
									<i>Optional</i>
								</dt>
								<dd>A function following the MochiKit.Base.compare function syntax           for comparing two items and returning 1, 0, or -1.  If no           function is passed, then the MochiKit.Base.compare() function           will be used.</dd>
							
								<dt>
									<b>ignore_n</b>
									<i>Optional, Default:  0</i>
								</dt>
								<dd>Identified the number of elements at the beginning of the array to           ignore during the sort.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The sorted array.</dd>
							
							</dl>
						
						
						

					
				
			
			
			<hr />
		</div>
		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.2 on Sun Aug 02 2009 20:49:02 GMT-0400 (EDT)
		</div>
	</body>
</html>
